﻿// ------------------------------------------------------------------------
// 版权信息
// 版权归重庆虫儿飞科技有限公司所有。
// 所有权利保留。
// 官方网站：https://netokit.com
// 许可证信息
// Neto.Kit 项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。
// 许可证的完整文本可以在源代码树根目录中的 LICENSE-APACHE 和 LICENSE-MIT 文件中找到。
// 
// 使用条款
// 使用本代码应遵守相关法律法规和许可证的要求。
// 
// 免责声明
// 对于因使用本代码而产生的任何直接、间接、偶然、特殊或后果性损害，我们不承担任何责任。
// 
// 其他重要信息
// Neto.Kit 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。
// 有关 Neto.Kit 项目的其他详细信息，请参阅位于源代码树根目录中的 COPYRIGHT 和 DISCLAIMER 文件。
// 
// 更多信息
// 请访问 https://netokit.com 获取更多关于 Neto.Kit 项目的许可证和版权信息。
// ------------------------------------------------------------------------

namespace Neto.Helpers;

/// <summary>
///     提供用于字节大小和存储单位之间转换的静态方法。
/// </summary>
public static class ByteSizeFormatter
{
    // 定义每种存储单位相对于字节的常量值（基于二进制前缀）
    private const double KiB = 1024;
    private const double MiB = KiB * KiB;
    private const double GiB = MiB * KiB;
    private const double TiB = GiB * KiB;
    private const double PB = TiB * KiB;
    private const double EB = PB * KiB;

    /// <summary>
    ///     将字节数量转换为指定的存储单位（KB、MB、GB、TB），保留指定的小数位数。
    /// </summary>
    /// <param name="bytes">待转换的字节数量。</param>
    /// <param name="unit">目标存储单位（KB、MB、GB、TB、PB、EB）。</param>
    /// <param name="decimalPlaces">转换结果应保留的小数位数，默认为2位。</param>
    /// <returns>转换后的存储大小字符串。</returns>
    /// <exception cref="ArgumentException">当指定的存储单位无效时抛出。</exception>
    public static string FormatBytes(long bytes, ByteUnit unit, int decimalPlaces = 2)
    {
        // 根据指定的存储单位计算字节大小
        var formattedSize = unit switch
        {
            ByteUnit.KB => bytes / KiB,
            ByteUnit.MB => bytes / MiB,
            ByteUnit.GB => bytes / GiB,
            ByteUnit.TB => bytes / TiB,
            ByteUnit.PB => bytes / PB,
            ByteUnit.EB => bytes / EB,
            _ => throw new ArgumentException("Invalid storage unit specified.", nameof(unit))
        };

        // 将计算结果格式化为指定小数位数的字符串
        return formattedSize.ToString($"N{decimalPlaces}");
    }

    /// <summary>
    ///     将字节数量转换为指定的存储单位（KB、MB、GB、TB），保留指定的小数位数。
    /// </summary>
    /// <param name="bytes">待转换的字节数量。</param>
    /// <param name="unit">目标存储单位（KB、MB、GB、TB）。</param>
    /// <param name="decimalPlaces">转换结果应保留的小数位数，默认为2位。</param>
    /// <returns>转换后的存储大小字符串。</returns>
    /// <exception cref="ArgumentException">当指定的存储单位无效时抛出。</exception>
    public static string ToFormatBytes(this long bytes, ByteUnit unit, int decimalPlaces = 2)
    {
        return FormatBytes(bytes, unit, decimalPlaces);
    }
}

/// <summary>
///     定义存储单位的枚举。
/// </summary>
public enum ByteUnit
{
    /// <summary>
    ///     千字节
    /// </summary>
    KB,

    /// <summary>
    ///     兆字节
    /// </summary>
    MB,

    /// <summary>
    ///     千兆字节
    /// </summary>
    GB,

    /// <summary>
    ///     太字节
    /// </summary>
    TB,

    /// <summary>
    ///     百京字节
    /// </summary>
    PB,

    /// <summary>
    ///     京字节
    /// </summary>
    EB
}